Use help_formatter to consistently format help output #6931

tautschnig · 2022-06-15T09:29:07Z

We previously did manual line breaks that either suited the source code
line length or approximated the output line width. help_formatter, however,
was specifically built to take care of this (and just wasn't widely
used). We can then also happily have clang-format take care of source
code formatting without impacting the resulting display.

Each commit message has a non-empty body, explaining why the change was made.
n/a Methods or procedures I have added are documented, following the guidelines provided in CODING_STANDARD.md.
n/a The feature or user visible behaviour I have added or modified has been documented in the User Guide in doc/cprover-manual/
Regression or unit tests are included, or existing tests cover the modified code (in this case I have detailed which ones those are in the commit message).
n/a My commit message includes data points confirming performance improvements (if claimed).
My PR is restricted to a single feature or bugfix.
n/a White-space or formatting changes outside the feature-related changed lines are in commits of their own.

codecov · 2022-06-15T10:40:04Z

Codecov Report

Patch coverage: 18.84% and project coverage change: +0.02% 🎉

Comparison is base (4e426d3) 78.80% compared to head (722918f) 78.82%.

Additional details and impacted files

@@             Coverage Diff             @@
##           develop    #6931      +/-   ##
===========================================
+ Coverage    78.80%   78.82%   +0.02%     
===========================================
  Files         1698     1699       +1     
  Lines       195118   195102      -16     
===========================================
+ Hits        153757   153798      +41     
+ Misses       41361    41304      -57

Files Changed	Coverage Δ
jbmc/src/janalyzer/janalyzer_parse_options.cpp	`48.43% <0.00%> (-0.16%)`	⬇️
jbmc/src/java_bytecode/java_bytecode_language.h	`76.47% <ø> (ø)`
jbmc/src/jbmc/jbmc_parse_options.cpp	`74.20% <0.00%> (-0.17%)`	⬇️
jbmc/src/jdiff/jdiff_parse_options.cpp	`65.62% <0.00%> (-0.70%)`	⬇️
...variable-sensitivity/variable_sensitivity_domain.h	`100.00% <ø> (ø)`
src/ansi-c/ansi_c_language.h	`75.00% <ø> (ø)`
src/cprover/cprover_parse_options.cpp	`56.25% <ø> (ø)`
src/crangler/crangler_parse_options.cpp	`52.94% <0.00%> (ø)`
src/goto-analyzer/goto_analyzer_parse_options.cpp	`71.84% <0.00%> (-0.43%)`	⬇️
src/goto-checker/solver_factory.h	`100.00% <ø> (ø)`
... and 27 more

... and 4 files with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

martin-cs

Good stuff but be aware of the potential revert of #6932

jbmc/src/janalyzer/janalyzer_parse_options.cpp

martin-cs · 2022-06-15T12:27:23Z

src/analyses/variable-sensitivity/variable_sensitivity_domain.h

-  "(vsd-liveness)"                                                             \
-                                                                               \
-    // clang-format off
+  "(vsd-liveness)"


Are we still doing the "put a \ at the end of even the last line so that new additions are just 1-line diffs" thing?

Might be useful, but clang-format takes them away. So I'd have to (re-)add clang-format off/on, which makes formatting more cumbersome. I'm not sure which is best, happy to take guidance!

martin-cs · 2022-06-15T12:28:51Z

src/analyses/variable-sensitivity/variable_sensitivity_domain.h

-  " --vsd-liveness               track variable liveness\n"                    \
-
-// cland-format on
+  help_entry(                                                                  \


I feel a bit weird about having the << operators for all but the first. I guess we have to out << HELP_VSD which is grammatical but ... it feels a bit weird.

I'm happy to move the << over into the macros, but I don't know whether it actually makes for less weirdness. I tripped over this myself when coming up with this patch...

src/goto-analyzer/goto_analyzer_parse_options.cpp

NlightNFotis

Hi Michael.

This looks tedious, but it's a very important step to establish some uniformity and a standard around the help options.

Thanks for taking the time to sort this out.

tautschnig · 2022-07-14T15:05:17Z

Pinging @chris-ryder as I believe I'll strictly need your approval here.

feliperodri

Changes in contracts LGTM.

remi-delmas-3000 · 2022-07-14T21:09:07Z

src/util/config.h

-  "(object-bits):"                                                             \
+  "(gcc)"
+
+#define HELP_CONFIG_PLATFORM                                                   \


Since help_entry is a function could we instead write these as c++ functions returning std::string and avoid the multi-line macros ?

remi-delmas-3000

Are the multi-line macros that just expand chais of calls to help_entry and concatenation using << (see #define HELP_CONFIG_LIBRARY for instance) really needed or could we just use C++ functions returning std::string everywhere ?

remi-delmas-3000

Are the multi-line macros that just expand chais of calls to help_entry and concatenation using << (see #define HELP_CONFIG_LIBRARY for instance) really needed or could we just use C++ functions returning std::string everywhere ?

tautschnig · 2022-07-15T09:35:54Z

Are the multi-line macros that just expand chais of calls to help_entry and concatenation using << (see #define HELP_CONFIG_LIBRARY for instance) really needed or could we just use C++ functions returning std::string everywhere ?

I'll work on this.

tautschnig · 2022-09-19T15:55:29Z

I should likely rebase/rework this to use #7141.

tautschnig · 2023-08-11T10:10:31Z

To anyone reviewing this: on this occasion, reviewing the overall diff will be more effective than doing individual commits (I'm mainly keeping the "Use help_entry" commit for sentimental reasons).

Modelled after help_entry's unit test.

We previously did manual line breaks that either suited the source code line length or approximated the output line width. help_entry, however, was specifically built to take care of this (and just wasn't widely used). We can then also happily have clang-format take care of source code formatting without impacting the resulting display.

First round of changes was done automatically: ``` sed -i 's/help_entry("\(--[^ ]*\)", "\(.*\)")/" {y\1} \\t \2\\n"/' \ src/*/*.h src/*/*.cpp src/analyses/variable-sensitivity/*.h \ jbmc/src/*/*.h jbmc/src/*/*.cpp ``` All further replacements were done manually.

All uses of `help_entry` have been converted to uses of `help_formatter`.

tautschnig added the cleanup label Jun 15, 2022

tautschnig assigned kroening and peterschrammel Jun 15, 2022

tautschnig requested review from peterschrammel and romainbrenguier as code owners June 15, 2022 09:29

tautschnig assigned feliperodri Jun 15, 2022

tautschnig requested review from chris-ryder, feliperodri, SaswatPadhi and remi-delmas-3000 as code owners June 15, 2022 09:29

tautschnig assigned martin-cs Jun 15, 2022

tautschnig requested review from martin-cs, kroening, NlightNFotis and thomasspriggs as code owners June 15, 2022 09:29

tautschnig force-pushed the feature/help_entry branch from d88808b to 7df479e Compare June 15, 2022 09:40

martin-cs approved these changes Jun 15, 2022

View reviewed changes

tautschnig force-pushed the feature/help_entry branch from 7df479e to e3a0992 Compare June 15, 2022 21:21

tautschnig force-pushed the feature/help_entry branch from e3a0992 to a2c2626 Compare July 13, 2022 15:09

NlightNFotis approved these changes Jul 14, 2022

View reviewed changes

SaswatPadhi approved these changes Jul 14, 2022

View reviewed changes

tautschnig assigned chris-ryder and unassigned martin-cs and feliperodri Jul 14, 2022

feliperodri approved these changes Jul 14, 2022

View reviewed changes

remi-delmas-3000 reviewed Jul 14, 2022

View reviewed changes

remi-delmas-3000 approved these changes Jul 14, 2022

View reviewed changes

tautschnig self-assigned this Jul 15, 2022

peterschrammel approved these changes Jul 18, 2022

View reviewed changes

tautschnig unassigned peterschrammel Jul 19, 2022

tautschnig mentioned this pull request Sep 19, 2022

CHC encoder #6717

Merged

5 tasks

tautschnig force-pushed the feature/help_entry branch from a2c2626 to 54e96da Compare September 30, 2022 07:39

NlightNFotis approved these changes Sep 30, 2022

View reviewed changes

tautschnig unassigned kroening and chris-ryder Oct 4, 2022

tautschnig mentioned this pull request Feb 23, 2023

Minor formatting fix to contracts help #7563

Merged

7 tasks

tautschnig force-pushed the feature/help_entry branch from 54e96da to 11c0865 Compare August 11, 2023 10:03

tautschnig requested review from TGWDB, qinheping, a team and esteffin as code owners August 11, 2023 10:03

tautschnig changed the title ~~Use help_entry to consistently format help output~~ Use help_formatter to consistently format help output Aug 11, 2023

tautschnig assigned kroening and qinheping and unassigned tautschnig Aug 11, 2023

tautschnig force-pushed the feature/help_entry branch from 11c0865 to 376d852 Compare August 11, 2023 10:07

tautschnig added 4 commits August 11, 2023 15:24

Add unit test of help_formatter

58fcebf

Modelled after help_entry's unit test.

Use help_formatter

28d4662

First round of changes was done automatically: ``` sed -i 's/help_entry("\(--[^ ]*\)", "\(.*\)")/" {y\1} \\t \2\\n"/' \ src/*/*.h src/*/*.cpp src/analyses/variable-sensitivity/*.h \ jbmc/src/*/*.h jbmc/src/*/*.cpp ``` All further replacements were done manually.

Remove help_entry, which is now unused

722918f

All uses of `help_entry` have been converted to uses of `help_formatter`.

tautschnig force-pushed the feature/help_entry branch from 376d852 to 722918f Compare August 11, 2023 15:24

kroening approved these changes Aug 12, 2023

View reviewed changes

kroening merged commit 08a466d into diffblue:develop Aug 12, 2023

tautschnig deleted the feature/help_entry branch August 14, 2023 10:49

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Use help_formatter to consistently format help output #6931

Use help_formatter to consistently format help output #6931

tautschnig commented Jun 15, 2022 •

edited

Loading

codecov bot commented Jun 15, 2022 •

edited

Loading

martin-cs left a comment

martin-cs Jun 15, 2022

tautschnig Jun 15, 2022

martin-cs Jun 15, 2022

tautschnig Jun 15, 2022

NlightNFotis left a comment

tautschnig commented Jul 14, 2022

feliperodri left a comment

remi-delmas-3000 Jul 14, 2022

remi-delmas-3000 left a comment

remi-delmas-3000 left a comment

tautschnig commented Jul 15, 2022

tautschnig commented Sep 19, 2022

tautschnig commented Aug 11, 2023

Use help_formatter to consistently format help output #6931

Use help_formatter to consistently format help output #6931

Conversation

tautschnig commented Jun 15, 2022 • edited Loading

codecov bot commented Jun 15, 2022 • edited Loading

Codecov Report

martin-cs left a comment

Choose a reason for hiding this comment

martin-cs Jun 15, 2022

Choose a reason for hiding this comment

tautschnig Jun 15, 2022

Choose a reason for hiding this comment

martin-cs Jun 15, 2022

Choose a reason for hiding this comment

tautschnig Jun 15, 2022

Choose a reason for hiding this comment

NlightNFotis left a comment

Choose a reason for hiding this comment

tautschnig commented Jul 14, 2022

feliperodri left a comment

Choose a reason for hiding this comment

remi-delmas-3000 Jul 14, 2022

Choose a reason for hiding this comment

remi-delmas-3000 left a comment

Choose a reason for hiding this comment

remi-delmas-3000 left a comment

Choose a reason for hiding this comment

tautschnig commented Jul 15, 2022

tautschnig commented Sep 19, 2022

tautschnig commented Aug 11, 2023

tautschnig commented Jun 15, 2022 •

edited

Loading

codecov bot commented Jun 15, 2022 •

edited

Loading